home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / LANG / FORTH / FORTHMAC / OLD / WORKARC / !Forthmacs.docs.ascii.convention < prev    next >
Encoding:
Text File  |  1996-06-15  |  7.0 KB  |  229 lines
  1.  
  2. General Information
  3. *******************
  4.  
  5.  
  6. Getting Started
  7. ===============
  8.  
  9. Before anything else you should always make a backup of your "Working 
  10. Disk" archive called WorkDisc.  
  11.  
  12. All "Working Disks" are ZIP (deflated) archives, they hold the 
  13. complete directory tree including RISC OS file attributes in one 
  14. single file called 'WorkDisc' .  This archive is packed using SparcFS, 
  15. you should use Sparc for unpacking (distributed discs come complete 
  16. with Sparc).  
  17.  
  18. This makes is easy to deliver RISC OS Forthmacs via BBS or other email 
  19. media.  In addition to this advantage, the zipped archives can be used 
  20. by different computers on other platforms.  
  21.  
  22. To install !Forthmacs on your harddisk just copy the !Forthmacs 
  23. directory inside the 'WorkDisc' .  
  24.  
  25. You can of course run RISC OS Forthmacs from the disk, but that will 
  26. be not so much fun even with RISC OS Forthmacs internal file-caching.  
  27. The RISC OS Version should be 3.1 or later, earlier versions do run 
  28. but miss some features.  
  29.  
  30. RISC OS Forthmacs needs at least about 300 kByte of ram but 512K to 
  31. 2MB are much better.  
  32.  
  33. In the main directory <!Forthmacs> you will see some files, 
  34. 'bin.run.forth' is the basic 'obey' file to start RISC OS Forthmacs 
  35. (risc_os.bin.Forthmacs).  It looks something like this: 
  36.     
  37.     Wimpslot -min 1024K
  38.     RMEnsure ColourTrans    0.52 RMLoad System:Modules.Colours
  39.     RMEnsure ColourTrans    0.52 Error Forthmacs needs ColourTrans 0.52 or later
  40.     If "<Wimp$ScrapDir>"="" then ERROR Forthmacs needs Wimp$ScrapDir for swapping
  41.     Set Forthmacs$Path @.,<Forthmacs$Dir>.,<Forthmacs$Dir>.tools.
  42.     Set Forthmacs$wimpmode 27
  43.     Forthmacs:risc_os.bin.Forthmacs %0
  44.     
  45. The first line sets the 'Wimpslotsize', the last calls the forth 
  46. binary.  
  47.  
  48.  
  49. %0 stands for the first parameter, this can be a filename that 
  50. RISC OS Forthmacs will immediatly start to interpret.  If this 
  51. parameter isn't set, 'auto ' is the default.  Note: This would be 
  52. auto.fth on other implementations.  
  53.  
  54. 'Set Forthmacs$Path @.,<Forthmacs$Dir>.,<Forthmacs$Dir>.tools.' will 
  55. tell RISC OS Forthmacs where to find it's files.  In target 
  56. applications you should set this path accordingly.  
  57.  
  58. 'Set Forthmacs$vidmode 27' tells the TERMINAL: about the wanted video 
  59. mode, the default is UNSET .  This doesn't swich the video mode, all 
  60. others are accepted as RISC OS 3.1 wimpmodes.  The 3.5 mode styles 
  61. will not be supported, future versions will run in WIMP.  
  62.  
  63.  
  64. Updating
  65. ========
  66.  
  67. To make updating easy and to keep net-costs low, all RISC OS Forthmacs 
  68. tools, applications, updates and add ons will follow a common 
  69. strategy: They are gzipped/tar archives holding only the files needed.  
  70.  
  71. The Sparc file-archives holding the "Working disc" are updated when 
  72. major improvements took place and the add on files use more than 
  73. 100kB.  
  74.  
  75. When you have got an update or an application archive you just copy 
  76. this archive to the 
  77.     risc_os.installing
  78. directory and run RISC OS Forthmacs, the installing is done 
  79. automatically for you.  
  80.  
  81. Hope this improves updating :-) 
  82.  
  83.  
  84. Features
  85. ========
  86.  
  87. 32-bit stacks and addresses 
  88.  
  89. structured decompilation 
  90.  
  91. macro assembler and disassembler 
  92.  
  93. Source-level debugging/tracing/single stepping 
  94.  
  95. Command line editing with interactive history editor 
  96.  
  97. command completion 
  98.  
  99. callfinder 
  100.  
  101. Operating system independent file system interface 
  102.  
  103. operating system interface compiler 
  104.  
  105. strings 
  106.  
  107. crash resistance ( also in multitasking ) 
  108.  
  109. run-time search order specification 
  110.  
  111. cooperative multitasking 
  112.  
  113. runtime profiler 
  114.  
  115. on-line documentation 
  116.  
  117. Assembly language debugging/tracing/single-stepping 
  118.  
  119. Floating point (optional) 
  120.  
  121. complete source code (optional) 
  122.  
  123. xmodem and serial interface tool 
  124.  
  125.  
  126. Upper Case vs. Lower Case
  127. =========================
  128.  
  129. In the older manuals Forth words were written in upper case LIKE THIS.  
  130. This was done to make those words stand out from the rest of the text.  
  131. The formatter now prints those keywords in bold-typewriter font like 
  132. FORTH. 
  133.  
  134. When you type the Forth words, you should use lower case as shown in 
  135. the glossary.  Also, Forth source code in files should be in lower 
  136. case.  
  137.  
  138. If you need to use upper case, read about the variable CAPS in the 
  139. Master Glossary.  
  140.  
  141. Note: There are very rare occasions when the formatting program 
  142. doesn't switch into bold-typewriter font, so don't worry if you find a 
  143. keyword in upper case.  
  144.  
  145.  
  146. Master Glossary
  147. ===============
  148.  
  149. Reference documentation for most RISC OS Forthmacs words appears in 
  150. the chapter "Master Glossary".  The key to the glossary notation is 
  151. the chapter "Glossary Notation".  The Master Glossary is sorted by 
  152. alphabetical order.  The chapter "Glossary Functional Index" lists the 
  153. words of the Master Glossary grouped by function.  
  154.  
  155. Documentation for the ARM-Assembler and Multitasking can be found in 
  156. special chapters.  
  157.  
  158.  
  159. Loading Files
  160. =============
  161.  
  162. To interpret Forth source code from a file named, for example, 'art ' 
  163. , use FLOAD like: 
  164.     fload art
  165. As you probably know the directories in Risc_OS are seperated by a dot 
  166. like 
  167.     risc_os.bin.Forthmacs
  168. Deep inside RISC OS Forthmacs, pathnames ending with 
  169. .DOC .TXT .EXE .FTH .IND .DAT are accepted as DOS-style pathnames and 
  170. converted to RISC OS pathnames.  This allows more portable code with 
  171. filenames.  
  172.  
  173. To edit files, use your favorite editor, this works very fine with 
  174. Deskedit, Zap, StrongED, Edit uEmacs or others.  
  175.  
  176. To learn more about files, read the chapter "Files".  
  177.  
  178.  
  179. Saving an Executable Image
  180. ==========================
  181.  
  182. After creating new definitions and changing things you may want to 
  183. save an executable file that includes those changes and additions.  
  184.     "" filename save-forth
  185. will do this for you.  The file will be added to the current directory 
  186. unless the pathname is explicitly specified.  The new file must be of 
  187. the absolute filetype.  
  188.  
  189. From now on, you can call up your own version of Forth with: 
  190.     * run filename
  191. In fact, you can automatically interpret Forth source code files as 
  192. well when you first start up Forth.  From supervisor ( or 'obey' 
  193. file): 
  194.     * run filename  sourcefile
  195.  
  196.  
  197. Interrupting a Listing
  198. ======================
  199.  
  200. When Forth is displaying a multi-line listing on the screen, in most 
  201. cases the listing may be interrupted by typing any character.  If the 
  202. character is "q" (for quit), the listing will be aborted.  If the 
  203. character is anything other than "q", the listing will pause, 
  204. displaying a "More?" prompt at the bottom of the screen.  
  205.  
  206. When the listing is paused, typing a "q" will cause the listing to be 
  207. aborted, and typing any other character will cause it to continue.  
  208.  
  209.  
  210. Copying the Manual
  211. ==================
  212.  
  213. The manual is copyrighted, and permission to copy in any way it is NOT 
  214. granted.  If you need extra copies, contact the RISC OS Forthmacs 
  215. support.  You can copy and give away the complete Working disk, but 
  216. not the manual.  
  217.  
  218. Online manuals are available on special request, both dvi and ascii 
  219. files are available at the moment.  
  220.  
  221. RISC OS Forthmacs support: 
  222.     Hanno Schwalm
  223.     Holunderstr. 10
  224.     D-28207 Bremen
  225.     Germany
  226.     Tel. 49 421 459996
  227.     schwalm@bre.winnet.de
  228.  
  229.